Syslog, CDR, SDR and Debug Parameters

Determines whether the device sends logs and error messages (e.g., CDRs) generated by the device to a syslog server.

Note:

Assigns an IP Interface from the IP Interfaces table (see Configuring IP Network Interfaces) for communication with the primary syslog server.

By default, the OAMP interface is used.

Note: The IP address version (IPv4 or IPv6) of the IP Interface and the syslog server's address must be the same.

Defines the address (IP address or FQDN) of the computer on which the primary syslog server is running. The syslog server is an application designed to collect the logs and error messages generated by the device.

The default IP address is 0.0.0.0.

Note:

Defines the UDP port of the primary syslog server.

The valid range is 0 to 65,535. The default port is 514.

Note: To configure secondary syslog servers, see Configuring Secondary Syslog Servers.

Defines the transport protocol for communicating with the primary syslog server.

Note: 

Assigns a TLS Context when the TLS transport protocol is used for communication with the syslog server (primary and secondary servers).

For configuring TLS Contexts, see Configuring TLS Certificate Contexts.

Defines the minimum severity level of messages included in the syslog message that is generated by the device.

The specified severity level and all higher severity levels are included in the syslog message. For example, if you configure the parameter to Alert, the syslog will include messages with Alert severity level and messages with Emergency severity level. The severity levels are listed below from highest to lowest severity.

Note:

Enables the device to send the syslog messages to the serial console (over the device's physical serial interface). This may be useful, for example, if you no longer have network access to the device and you would like to perform diagnostics.

Note:

Defines the maximum size (in kilobytes) of each persistent system log file, after which log rotation occurs.

The valid value range is 10 to 2,000 KB. The default is 1,024 KB.

For more information on persistent logging, see Configuring and Viewing Persistent Logging Storage.

Defines the maximum age (in minutes) of each persistent system log file, after which log rotation occurs.

The valid value range is 0 to 71,582. The default is 0 (unlimited).

For more information on persistent logging, see Configuring and Viewing Persistent Logging Storage.

Enables the device to log (syslog) HTTP requests and responses (like CURL's verbose data) received from HTTP clients.

Note: To log only specific HTTP clients (based on URL filters), see the [HTTPLogFilter] parameter.

Defines the HTTP clients whose requests and responses you want the device to log, based on the presence of specific strings within their URLs.

The valid value is a string of up to 256 characters. You can configure the parameter with multiple strings, where each string is separated by a space (e.g., 'url1 url2 url3'). The value must be enclosed by single quotation marks (' '). The default is an empty string (' '), which means that the device logs requests and responses from all HTTP clients.

Note: To enable the logging of HTTP client requests and responses, see the [EnableHttpClientDbgMsg] parameter.

Defines the address (IPv4 or IPv6, or FQDN) of the syslog server to where the device sends the CDRs.

By default, no address is defined. If not configured, the device sends the CDRs (with the syslog messages) to the syslog server configured by the [SyslogServerIP] parameter. If you configure an address for the [CDRSyslogServerIP] parameter, the device sends the CDRs only to this CDR syslog server and not to the syslog server configured by the [SyslogServerIP] parameter.

Note:

Defines SIP release cause codes that if received for the call, the devicedoesn't sent Call-End CDRs for the call.

The valid value is 300 through to 699. You can configure the parameter with multiple codes using a comma to separate them (e.g., 301,400,404). You can also use "xx" to denote a range (e.g., 3xx).

Enables the device to not send Call-End CDRs if the call's duration is zero (0).

Enables signaling-related CDRs to be sent to a syslog server and defines the call stage at which they are sent.

Note:

Enables media-related CDRs of SBC calls to be sent to a syslog server and defines the call stage at which they are sent.

Note:

Enables signaling-related CDRs to be sent to a REST server and defines the call stage at which they are sent.

Note:

Defines the REST server (configured in the Remote Web Services table) to where the device sends CDRs through REST API.

The valid value is a string (i.e., name of the REST server). By default, no value is defined.

Note:

Defines the SIP response code that you want the device to consider as a call success, which is indicated by the optional 'Call Success' field in the sent CDR. This parameter overrides the device's default behavior of how it considers calls a success or failure based on SIP responses.

The valid value is string of up to 128 characters to represent SIP response codes (e.g., 404). You can configure the parameter with multiple response codes, whereby each code is separated by a comma without spaces before or after (e.g., 404,408,406). You can also configure a range of responses using the "xx" wildcard (e.g., 4xx,502). By default, no value is defined.

Note:

For all other SIP failure response codes, the device considers them as a call failure.

Defines the SIP response codes that you want the device to consider as call failure, which is indicated by the optional 'Call Success' field in the sent CDR. This parameter overrides the device's default behavior of how it considers calls a success or failure based on SIP responses.

The valid value is string of up to 128 characters to represent SIP response codes (e.g., 486). You can configure the parameter with multiple response codes, whereby each code is separated by a comma without spaces before or after (e.g., 486,408,406). You can also configure a range of responses using the "xx" wildcard (e.g., 4xx,502). By default, no value is defined.

Note:

For all other SIP failure response codes, the device considers them as a call failure.

Defines the internal response codes (generated by the device) that you want the device to consider as call success, which is indicated by the optional 'Call Success' field in the sent CDR. This parameter overrides the device's default behavior of how it considers calls a success or failure based on internally responses.

The valid value is string of up to 128 characters to represent internal response codes (e.g., 851). You can configure the parameter with multiple response codes, whereby each code is separated by a comma without spaces before or after (e.g., 851,320). You can also configure a range of responses using the "xx" wildcard (e.g., 8xx,320). By default, no value is defined.

Note:

Defines the internal response codes (generated by the device) that you want the device to consider as call failure, which is indicated by the optional 'Call Success' field in the sent CDR. This parameter overrides the device's default behavior of how it considers calls a success or failure based on internally responses.

The valid value is string of up to 128 characters to represent internal response codes (e.g., 851). You can configure the parameter with multiple response codes, whereby each code is separated by a comma without spaces before or after (e.g., 851,320). You can also configure a range of responses using the "xx" wildcard (e.g., 8xx,320). By default, no value is defined.

Note:

Defines if the device considers a call as a success or failure when the internal response (generated by the device) "GWAPP_NO_USER_RESPONDING" (18) is received before call connect (SIP 200 OK).

Defines if the device considers a call as a success or failure when the internal response (generated by the device) "GWAPP_NO_USER_RESPONDING" (18) is received after call connect (SIP 200 OK).

Defines if the device considers a call as a success or failure when the internal response (generated by the device) "RELEASE_BECAUSE_CALL_TRANSFERRED" (807) is generated before call connect (SIP 200 OK).

Defines if the device considers a call as a success or failure when the internal response (generated by the device) "RELEASE_BECAUSE_CALL_TRANSFERRED" (807) is generated after call connect (SIP 200 OK).

Enables syslog debug reporting and logging level.

Enables creation of CDR messages for non-call SIP dialogs (such as SUBSCRIBE, OPTIONS, and REGISTER).

Enables the device to accumulate and bundle multiple debug messages into a single UDP packet and then send it to a syslog server. The benefit of this feature is that it reduces the number of UDP syslog packets, thereby improving (optimizing) CPU utilization.

Note: The size of the bundled message is configured by the [MaxBundleSyslogLength] parameter.

Defines the maximum size (in bytes) threshold of logged syslog messages bundled into a single UDP packet, after which they are sent to a syslog server.

The valid value range is 0 to 1220 (where 0 indicates that no bundling occurs). The default is 1220.

Note: The parameter is applicable only if the [GWDebugLevel] parameter is enabled.

Enables the protection of the device's CPU resources during debug reporting, ensuring voice traffic is unaffected. If CPU resources drop (i.e., high CPU usage) to a critical level (threshold), the device automatically lowers the debug level to free up CPU resources that were required for the previous debug-level functionality. When sufficient CPU resources become available again, the device increases the debug level. The threshold is configured by the 'Debug Level High Threshold' parameter (see below).

Defines the threshold (in percentage) for automatically switching to a different debug level, depending on CPU usage. The parameter is applicable only if the 'syslog CPU Protection' parameter is enabled.

The valid value is 0 to 100. The default is 90.

The debug level is changed upon the following scenarios:

For example, assume that the threshold is set to 70% and the Debug Level to Detailed (5). When CPU usage reaches 70%, the debug level is reduced to Basic (1). When CPU usage increases by 5% or more than the threshold (i.e., greater than 75%), the debug level is disabled - No Debug (0). When the CPU usage decreases to 5% less than the threshold (e.g., 65%), the debug level is increased to Basic (1). When the CPU usage decreases to 20% less than the threshold (e.g., 50%), the debug level changes to Detailed (5).

Note: The device doesn't increase the debug level to a level that is higher than what you configured for the 'Debug Level' parameter.

Defines the time zone that is displayed with the timestamp in CDRs. The timestamp appears in the CDR fields "Setup Time", "Connect Time", and "Release Time".

The valid value is a string of up to six characters. The default is UTC. For example, if you configure the parameter TimeZoneFormat = GMT+11, the timestamp in CDRs are generated with the following time zone display:

17:47:45.411 GMT+11 Sun Jan 03 2018

Note: The time zone is only for display purposes; it doesn't configure the actual time zone.

Defines the unit of measurement for call duration ("Duration" field) in CDRs generated by the device.

The parameter applies to CDRs for syslog, RADIUS, local-device storage, and CDR history displayed in the Web interface.

Enables or disables the inclusion of the sequence number (S=) in CDR Syslog messages.

Enables the use of the Global Session ID in SIP messages (AC-Session-ID header), which is a unique identifier of the call session, even if it traverses multiple devices.

For more information, see Enabling Same Call Session ID over Multiple Devices.

Defines the operations (activities) performed in the Web interface that are reported to a syslog server.

Note: For the ini file parameter, enclose values in single quotation marks. To configure the ini file parameter with multiple values, use a comma-separated list, for example: ActivityListToLog = 'PVC', 'AFL', 'DR'.

Defines the maximum number of lines of parameters from the loaded incremental ini file to log for the Activity Types to Report feature. The parameter is applicable when you configure the [ActivityListToLog] parameter to also include the INI value.

The valid value is 0 to 2,000. The default is 1,000.

Note: The maximum number of lines doesn't count empty lines or lines containing only comments.

Enables the monitoring, through syslog messages, of parameters that are modified on-the-fly.

Defines the IP address (IPv4 or IPv6) of the server for capturing debug recording.

Defines the UDP port of the server for capturing debug recording.

The default is 925.

Defines the maximum duration (in minutes) for the debug recording process. When this timer expires, the device automatically stops debug recording (unless you've explicitly stopped it before the timer expires, as described in Starting and Stopping Debug Recording).

The valid value is 1 to 10,080 (7 days). The default is 60 (1 hour).

Note: If debug recording is currently running (i.e., was started), the device resets the debug recording timer upon the following:

Starts or stops debug recording.

For more information on starting and stopping debug recording, see Starting and Stopping Debug Recording.

Note: The CLI command also displays the current debug recording status (Started or Stopped), and resets the debug recording timer (configured by the [DebugRecordingTimeout] parameter).

Defines the IP Interface through which the device sends captured traffic to the debug server.

The valid value is the name of the IP Interface, as configured in the IP Interfaces table (see Configuring IP Network Interfaces). The default is the OAMP interface.

Enables the automatic generation of a Core Dump file upon a device crash.

Defines the IP address of the remote server where you want the device to send the Core Dump file.

By default, no IP address is defined.

Enables the device to send SIP call messages to OVOC so that OVOC can display SIP call dialog sessions as SIP call flow diagrams.

For more information, see Enabling SIP Call Flow Diagrams in OVOC.

Defines the maximum size (in kilobytes) of the system log file.

The valid value range is 10 to 2000 KB. The default is 500 KB.

To view the logged information in this file, use the CLI command show system log.

Defines packet-loss percentage ranges that are used in sent syslog messages to report packet loss in incoming media streams (RTP) in 15-second intervals.

The valid value range is 1 to 1,000. The default is 5, 10, 20, 50.

The syntax for configuring the parameter is: PLThresholdLevelsPerMille = Level1, Level2, Level3, Level4

Where the levels represent the following ranges in the syslog:

For example (using default values):

PLThresholdLevelsPerMille = 5,10,20,50

Therefore, the ranges are:

For more information, see Packet Loss Indication in Syslog.

Defines the type of SDRs to generate for syslog or local storage.

Defines the time (in minutes) of the call at which the device generates the first Intermediate SDR.

The valid value is 0 to 20. The default is 0 (i.e., not generated).

For more information, see Configuring Intervals for Intermediate SDRs.

Note:

Defines the time (in minutes) between each Intermediate SDR that the device generates during the call.

The valid value is 30 to 90. The default is 60 (i.e., every hour).

For more information, see Configuring Intervals for Intermediate SDRs.

Note: The parameter is applicable only to Intermediate SDRs (i.e., 'SDR Record Type' or 'REST SDR Record Type' parameters are configured to any value that includes "INTERMEDIATE").

Enables the device to send SDRs to a syslog server.

Defines the address (IPv4 or IPv6 address, or FQDN) of the syslog server to where the device sends the SDRs.

By default, no value is defined.

Enables the inclusion of a sequence number (S=) in SDR Syslog messages.

Enables the device to send SDRs to an HTTP-based REST server, using its REST API.

Defines the SDR type(s) to generate for sending to a REST server.

Defines the name of the REST server (configured in the Remote Web Services table) to where the device sends SDRs.

By default, no value is defined.

Enables the device to store generated SDRs locally.

Defines the size (in kilobytes) of each locally stored SDR file (before compression). When the Current file reaches this size, the device creates a file containing all the SDRs from the Current file.

The valid value is 1,024 to 1,048,567. The default is 10,240.

Note: SDR file creation works together with the 'Rotation Period' parameter, whereby the file is created as soon as one of the parameter's ('File Size' or 'Rotation Period') settings are fulfilled (whichever occurs first). For example, if the 'File Size' parameter is 100 and 'Rotation Period' is 60, and the file size reaches 100 kbytes after only 30 minutes, the device creates the file.

Defines the maximum number of locally stored SDR files. If the maximum number is reached and a new file is created, the oldest file is deleted to make space for the new file (i.e., FIFO).

The valid value is 2 to 65,535. The default is 5.

Defines the filename for locally stored SDRs, using format specifiers.

The valid value is a string of up to 63 characters. The default is SDR__%y.%m.%d-%H.%M.%S_%qqqqq.csv, where:

Defines how often (in minutes) the device creates a new file for locally stored SDRs. For example, if configured to 60, every hour it creates a file containing all the SDRs from the Current file.

The valid value is 2 to 1,440. The default is 60.

Note:

Defines the file compression format for locally stored SDR files.

Note: If you modify the parameter, the selected file format is applied to all existing SDR files (in addition to future files).

Defines the periodic interval (in seconds) when the device checks if a locally stored SDR file is available for sending to the remote server. For example, if you configure the parameter to 10, the device checks for a file every 10 seconds. If there is a file, it sends it to the server.

The valid value is 0 to 60. The default is 1. A value of 0 means that the device doesn't send any SDR files to the server.

Defines the maximum number of locally stored SDR files (i.e., batch of files) that the device sends to the remote server in each file transfer operation.

The valid value is 1 to 20. The default is 10.

Defines the size (in kilobytes) of each locally stored CDR file (before compression). When the Current file reaches this size, the device creates a CDR file containing all the CDRs from the Current file.

The valid value is 1024 to 1048567. The default is 10240.

Note:

Defines the maximum number of locally stored CDR files. If the maximum number is reached and a new file is created, the oldest file is deleted to make space for the new file (i.e., FIFO).

The valid value is 2 to 65535 . The default is 5.

Note: The parameter is applicable only to local storage of CDRs.

Defines how often (in minutes) the device creates a new CDR file for locally stored CDRs. For example, if configured to 60, every hour it creates a CDR file containing all the CDRs from the Current file.

The valid value is 2 to 1440. The default is 60.

Note:

Defines the file compression format for locally stored CDR files.

Note:

Defines the CDR filename for locally stored CDRs, using format specifiers.

The valid value is a string of up to 63 characters. The default is CDR__%y.%m.%d-%H.%M.%S_%qqqqq.csv, where:

For more information, see Storing CDRs Locally on the Device.

Note: The parameter is applicable only to local storage of CDRs.

Defines the periodic interval (in seconds) when the device checks if a locally stored CDR file is available for sending to the remote CDR server. For example, if you configure the parameter to 10, the devicechecks for a CDR file every 10 seconds. If there is a file, it sends it to the server.

The valid value is 0 to 60. The default is 1. A value of 0 means that the device doesn't send any CDR files to the server.

Note: The parameter is applicable only to local storage of CDRs.

Defines the maximum number of locally stored CDR files (i.e., batch of files) that the device sends to the remote server in each transfer operation.

The valid value is 1 to 20. The default is 10.

Note: The parameter is applicable only to local storage of CDRs.

Enables local storage of debug recording files.

Note: If you disable local storage (i.e., parameter configured to Disable), the device deletes all stored debug recording files. In addition, it no longer reserves storage space previously allocated for debug recording files.

Starts debug recording file creation and local storage.

Defines the maximum size (in megabytes) of the debug recording file (compressed). When the Current file reaches this size, the device creates a file. However, if the 'Rotation Period' parameter is reached before the file has reached this maximum size, the file is created.

The valid value is 0 to 100. The default is 50.

Defines the maximum number of debug recording files that can be stored locally. Depending on the configuration of the 'File Mode' parameter, if this maximum is reached, a new file replaces the oldest file (i.e., FIFO) or the device stops debug recording.

The valid value is 0 to 1,000. The default is 20.

Defines the file creation method when the number of maximum files is reached (as configured by the 'Number of Files' parameter).

Defines the periodic duration (in minutes) of how often a debug recording file is created from the Current file (even if empty). For example, if configured to 60, a file is created every hour (or before if the maximum size is reached).

The valid value is 1 to 1,440 (i.e., 24 hours). The default is 1.

Defines the filtering of IP traces for log filtering rules (in the Logging Filters table) whose 'Filter Type' parameter is configured to IP Trace.

Filters IP traces by a specific Ethernet port.

Filters IP traces by a specific Ethernet Group.

Filters IP traces by a specific VLAN ID.

Enables the masking of DTMF and other digits detected by the device in the generated syslog messages and debug recording.

For more information, see Masking Digits in Syslog Messages.

Enables the masking of personally identifiable information (PII) in CDRs and SDRs generated by the device.

For more information, see Masking PII in CDRs and SDRs.

Defines the number of characters in the PII element to show when the 'Mask PII in CDRs' parameter is configured to Mask PII in Detailed Records. The rest of the characters are masked (each by an asterisk sign).

The valid value is 0 to 255. The default is 0 (masks all characters).

For more information, see Masking PII in CDRs and SDRs.

Defines from where in the PII element to show the number of characters specified by the 'Number of Unmasked Characters in PII' parameters, when the Mask Private Information in CDRs' parameter is configured to Mask PII in Detailed Records.

For more information, see Masking PII in CDRs and SDRs.

Enables the PII masking (with asterisks) of phone numbers, URI user parts, and display names in CDRs that the device sends to OVOC.

For more information, see Masking PII in CDRs and SDRs.